<?xml version="1.0" encoding="UTF-8"?>
<html filename="docs/SAX/IContentHandler.html">
<body>
<a id="#top"/>
<h1>
	                Interface Summary : IContentHandler </h1> Receive notification of the logical content of a document.

 <blockquote>
 <em>This module, both source code and documentation, is in the
 Public Domain, and comes with <strong>NO WARRANTY</strong>.</em>
 </blockquote>

 <p>This is the main interface that most SAX applications
 implement: if the application needs to be informed of basic parsing
 events, it implements this interface and registers an instance with
 the SAX parser using the <a href="../SAX/IXMLReader.html#setContentHandler">IXMLReader</a>
 The parser uses the instance to report basic document-related events
 like the start and end of elements and character data.</p>

 <p>The order of events in this interface is very important, and
 mirrors the order of information in the document itself.  For
 example, all of an element's content (character data, processing
 instructions, and/or subelements) will appear, in order, between
 the startElement event and the corresponding endElement event.</p>

 <p>This interface is similar to the now-deprecated SAX 1.0
 DocumentHandler interface, but it adds support for Namespaces
 and for reporting skipped entities (in non-validating XML
 processors).</p>

<br/><b>Since : </b> SAX 2.0
<br/><b>See : </b> <a href="../SAX/IXMLReader.html">IXMLReader</a>
<br/><b>See : </b> <a href="../SAX/IDTDHandler.html">IDTDHandler</a>
<br/><b>See : </b> <a href="../SAX/IErrorHandler.html">IErrorHandler</a>
<h2>
	              Methods
	            </h2>
<div style="padding-left:10px">
<a href="#setDocumentLocator">
	                  procedure
	                 setDocumentLocator(ILocator)</a>
<br/>
<a href="#startDocument">
	                  procedure
	                 startDocument()</a>
<br/>
<a href="#endDocument">
	                  procedure
	                 endDocument()</a>
<br/>
<a href="#startPrefixMapping">
	                  procedure
	                 startPrefixMapping(SAXString, SAXString)</a>
<br/>
<a href="#endPrefixMapping">
	                  procedure
	                 endPrefixMapping(SAXString)</a>
<br/>
<a href="#startElement">
	                  procedure
	                 startElement(SAXString, SAXString, SAXString, IAttributes)</a>
<br/>
<a href="#endElement">
	                  procedure
	                 endElement(SAXString, SAXString, SAXString)</a>
<br/>
<a href="#characters">
	                  procedure
	                 characters(SAXString)</a>
<br/>
<a href="#ignorableWhitespace">
	                  procedure
	                 ignorableWhitespace(SAXString)</a>
<br/>
<a href="#processingInstruction">
	                  procedure
	                 processingInstruction(SAXString, SAXString)</a>
<br/>
<a href="#skippedEntity">
	                  procedure
	                 skippedEntity(SAXString)</a>
<br/>
</div>
<br/>
<hr width="100%"/>
<a name="#setDocumentLocator">
<p>
<b>procedure</b> setDocumentLocator(<b>const</b> locator : ILocator); </p>
</a> Receive an object for locating the origin of SAX document events.

 <p>SAX parsers are strongly encouraged (though not absolutely
 required) to supply a locator: if it does so, it must supply
 the locator to the application by invoking this method before
 invoking any of the other methods in the ContentHandler
 interface.</p>

 <p>The locator allows the application to determine the end
 position of any document-related event, even if the parser is
 not reporting an error.  Typically, the application will
 use this information for reporting its own errors (such as
 character content that does not match an application's
 business rules).  The information returned by the locator
 is probably not sufficient for use with a search engine.</p>

 <p>Note that the locator will return correct information only
 during the invocation SAX event callbacks after
 <a href="../SAX/IContentHandler.html#startDocument">startDocument</a> returns and before
 <a href="../SAX/IContentHandler.html#endDocument">endDocument</a> is called.  The
 application should not attempt to use it at any other time.</p>

<br/><b>Parameter : </b> locator An object that can return the location of
                any SAX document event.
<br/><b>See : </b> <a href="../SAX/ILocator.html">ILocator</a>
<br/>
<p>
<a href="#top">Top</a>
</p>
<hr width="100%"/>
<a name="#startDocument">
<p>
<b>procedure</b> startDocument(); </p>
</a> Receive notification of the beginning of a document.

 <p>The SAX parser will invoke this method only once, before any
 other event callbacks (except for
 <a href="../SAX/IContentHandler.html#setDocumentLocator">setDocumentLocator</a>).</p>

<br/><b>Exception : </b> ESAXException Any SAX exception.
<br/><b>See : </b> <a href="../SAX/IContentHandler.html#endDocument">IContentHandler.endDocument</a>
<br/>
<p>
<a href="#top">Top</a>
</p>
<hr width="100%"/>
<a name="#endDocument">
<p>
<b>procedure</b> endDocument(); </p>
</a> Receive notification of the end of a document.

 <p>The SAX parser will invoke this method only once, and it will
 be the last method invoked during the parse.  The parser shall
 not invoke this method until it has either abandoned parsing
 (because of an unrecoverable error) or reached the end of
 input.</p>

<br/><b>Exception : </b> ESAXException Any SAX exception.
<br/><b>See : </b> <a href="../SAX/IContentHandler.html#startDocument">IContentHandler.startDocument</a>
<br/>
<p>
<a href="#top">Top</a>
</p>
<hr width="100%"/>
<a name="#startPrefixMapping">
<p>
<b>procedure</b> startPrefixMapping(<b>const</b> prefix : SAXString; <b>const</b> uri : SAXString); </p>
</a> Begin the scope of a prefix-URI Namespace mapping.

 <p>The information from this event is not necessary for
 normal Namespace processing: the SAX XML reader will
 automatically replace prefixes for element and attribute
 names when the <code>http://xml.org/sax/features/namespaces</code>
 feature is <var>true</var> (the default).</p>

 <p>There are cases, however, when applications need to
 use prefixes in character data or in attribute values,
 where they cannot safely be expanded automatically; the
 start/endPrefixMapping event supplies the information
 to the application to expand prefixes in those contexts
 itself, if necessary.</p>

 <p>Note that start/endPrefixMapping events are not
 guaranteed to be properly nested relative to each other:
 all startPrefixMapping events will occur immediately before the
 corresponding <a href="../SAX/IContentHandler.html#startElement">startElement</a> event,
 and all <a href="../SAX/IContentHandler.html#endPrefixMapping">endPrefixMapping</a>
 events will occur immediately after the corresponding
 <a href="../SAX/IContentHandler.html#endElement">endElement</a> event
 but their order is not otherwise
 guaranteed.</p>

 <p>There should never be start/endPrefixMapping events for the
 &quot;xml&quot; prefix, since it is predeclared and immutable.</p>

<br/><b>Parameter : </b> prefix The Namespace prefix being declared.
               An empty string is used for the default element namespace,
               which has no prefix.
<br/><b>Parameter : </b> uri The Namespace URI the prefix is mapped to.
<br/><b>Exception : </b> ESAXException The client may throw
            an exception during processing.
<br/><b>See : </b> <a href="../SAX/IContentHandler.html#endPrefixMapping">IContentHandler.endPrefixMapping</a>
<br/><b>See : </b> <a href="../SAX/IContentHandler.html#startElement">IContentHandler.startElement</a>
<br/>
<p>
<a href="#top">Top</a>
</p>
<hr width="100%"/>
<a name="#endPrefixMapping">
<p>
<b>procedure</b> endPrefixMapping(<b>const</b> prefix : SAXString); </p>
</a> End the scope of a prefix-URI mapping.

 <p>See <a href="../SAX/IContentHandler.html#startPrefixMapping">startPrefixMapping</a> for
 details.  These events will always occur immediately after the
 corresponding <a href="../SAX/IContentHandler.html#endElement">endElement</a> event, but the order of
 <a href="../SAX/IContentHandler.html#endPrefixMapping">endPrefixMapping</a> events is not otherwise
 guaranteed.</p>

<br/><b>Parameter : </b> prefix The prefix that was being mapped.
               Use the empty string when a default mapping scope ends.
<br/><b>Exception : </b> ESAXException The client may throw
            an exception during processing.
<br/><b>See : </b> <a href="../SAX/IContentHandler.html#startPrefixMapping">IContentHandler.startPrefixMapping</a>
<br/><b>See : </b> <a href="../SAX/IContentHandler.html#endElement">IContentHandler.endElement</a>
<br/>
<p>
<a href="#top">Top</a>
</p>
<hr width="100%"/>
<a name="#startElement">
<p>
<b>procedure</b> startElement(<b>const</b> uri : SAXString; <b>const</b> localName : SAXString; <b>const</b> qName : SAXString; <b>const</b> atts : IAttributes); </p>
</a> Receive notification of the beginning of an element.

 <p>The Parser will invoke this method at the beginning of every
 element in the XML document; there will be a corresponding
 <a href="../SAX/IContentHandler.html#endElement">endElement</a> event for every startElement event
 (even when the element is empty). All of the element's content will be
 reported, in order, before the corresponding endElement
 event.</p>

 <p>This event allows up to three name components for each
 element:</p>

 <ol>
 <li>the Namespace URI;</li>
 <li>the local name; and</li>
 <li>the qualified (prefixed) name.</li>
 </ol>

 <p>Any or all of these may be provided, depending on the
 values of the <var>http://xml.org/sax/features/namespaces</var>
 and the <var>http://xml.org/sax/features/namespace-prefixes</var>
 properties:</p>

 <ul>
 <li>the Namespace URI and local name are required when
 the namespaces property is <var>true</var> (the default), and are
 optional when the namespaces property is <var>false</var> (if one is
 specified, both must be);</li>
 <li>the qualified name is required when the namespace-prefixes property
 is <var>true</var>, and is optional when the namespace-prefixes property
 is <var>false</var> (the default).</li>
 </ul>

 <p>Note that the attribute list provided will contain only
 attributes with explicit values (specified or defaulted):
 #IMPLIED attributes will be omitted.  The attribute list
 will contain attributes used for Namespace declarations
 (xmlns* attributes) only if the
 <code>http://xml.org/sax/features/namespace-prefixes</code>
 property is true (it is false by default, and support for a
 true value is optional).</p>

 <p>Like <a href="../SAX/IContentHandler.html#characters">characters</a>, attribute values may have
 characters that need more than one <code>char</code> value.</p>

<br/><b>Parameter : </b> uri The Namespace URI, or the empty string if the
        element has no Namespace URI or if Namespace
        processing is not being performed.
<br/><b>Parameter : </b> localName The local name (without prefix), or the
        empty string if Namespace processing is not being
        performed.
<br/><b>Parameter : </b> qName The qualified name (with prefix), or the
        empty string if qualified names are not available.
<br/><b>Parameter : </b> atts The attributes attached to the element.  If
        there are no attributes, it shall be an empty
        IAttributes object.
<br/><b>Exception : </b> ESAXException Any SAX exception.
<br/><b>See : </b> <a href="../SAX/IContentHandler.html#endElement">IContentHandler.endElement</a>
<br/><b>See : </b> <a href="../SAX/IAttributes.html">IAttributes</a>
<br/>
<p>
<a href="#top">Top</a>
</p>
<hr width="100%"/>
<a name="#endElement">
<p>
<b>procedure</b> endElement(<b>const</b> uri : SAXString; <b>const</b> localName : SAXString; <b>const</b> qName : SAXString); </p>
</a> Receive notification of the end of an element.

 <p>The SAX parser will invoke this method at the end of every
 element in the XML document; there will be a corresponding
 <a href="../SAX/IContentHandler.html#startElement">startElement</a> event for every endElement
 event (even when the element is empty).</p>

 <p>For information on the names, see startElement.</p>

<br/><b>Parameter : </b> uri The Namespace URI, or the empty string if the
        element has no Namespace URI or if Namespace
        processing is not being performed.
<br/><b>Parameter : </b> localName The local name (without prefix), or the
        empty string if Namespace processing is not being
        performed.
<br/><b>Parameter : </b> qName The qualified XML 1.0 name (with prefix), or the
        empty string if qualified names are not available.
<br/><b>Exception : </b> ESAXException Any SAX exception.
<br/>
<p>
<a href="#top">Top</a>
</p>
<hr width="100%"/>
<a name="#characters">
<p>
<b>procedure</b> characters(<b>const</b> ch : SAXString); </p>
</a> Receive notification of character data.

 <p>The Parser will call this method to report each chunk of
 character data.  SAX parsers may return all contiguous character
 data in a single chunk, or they may split it into several
 chunks; however, all of the characters in any single event
 must come from the same external entity so that the Locator
 provides useful information.</p>

 <p>The application must not attempt to read from the array
 outside of the specified range.</p>

 <p>Individual characters may consist of more than one Java
 <code>char</code> value.  There are two important cases where this
 happens, because characters can't be represented in just sixteen bits.
 In one case, characters are represented in a <em>Surrogate Pair</em>,
 using two special Unicode values. Such characters are in the so-called
 &quot;Astral Planes&quot;, with a code point above U+FFFF.  A second case involves
 composite characters, such as a base character combining with one or
 more accent characters. </p>

 <p> Your code should not assume that algorithms using
 <code>char</code>-at-a-time idioms will be working in character
 units; in some cases they will split characters.  This is relevant
 wherever XML permits arbitrary characters, such as attribute values,
 processing instruction data, and comments as well as in data reported
 from this method.  It's also generally relevant whenever Java code
 manipulates internationalized text; the issue isn't unique to XML.</p>

 <p>Note that some parsers will report whitespace in element
 content using the <a href="../SAX/IContentHandler.html#ignorableWhitespace">ignorableWhitespace</a>
 method rather than this one (validating parsers <em>must</em>
 do so).</p>

<br/><b>Parameter : </b> ch The characters from the XML document.
<br/><b>Exception : </b> ESAXException Any SAX exception.
<br/><b>See : </b> <a href="../SAX/IContentHandler.html#ignorableWhitespace">IContentHandler.ignorableWhitespace</a>
<br/><b>See : </b> <a href="../SAX/ILocator.html">ILocator</a>
<br/>
<p>
<a href="#top">Top</a>
</p>
<hr width="100%"/>
<a name="#ignorableWhitespace">
<p>
<b>procedure</b> ignorableWhitespace(<b>const</b> ch : SAXString); </p>
</a> Receive notification of ignorable whitespace in element content.

 <p>Validating Parsers must use this method to report each chunk
 of whitespace in element content (see the W3C XML 1.0 recommendation,
 section 2.10): non-validating parsers may also use this method
 if they are capable of parsing and using content models.</p>

 <p>SAX parsers may return all contiguous whitespace in a single
 chunk, or they may split it into several chunks; however, all of
 the characters in any single event must come from the same
 external entity, so that the Locator provides useful
 information.</p>

 <p>The application must not attempt to read from the array
 outside of the specified range.</p>

<br/><b>Parameter : </b> ch The characters from the XML document.
<br/><b>Exception : </b> ESAXException Any SAX exception.
<br/><b>See : </b> <a href="../SAX/IContentHandler.html#characters">IContentHandler.characters</a>
<br/>
<p>
<a href="#top">Top</a>
</p>
<hr width="100%"/>
<a name="#processingInstruction">
<p>
<b>procedure</b> processingInstruction(<b>const</b> target : SAXString; <b>const</b> data : SAXString); </p>
</a> Receive notification of a processing instruction.

 <p>The Parser will invoke this method once for each processing
 instruction found: note that processing instructions may occur
 before or after the main document element.</p>

 <p>A SAX parser must never report an XML declaration (XML 1.0,
 section 2.8) or a text declaration (XML 1.0, section 4.3.1)
 using this method.</p>

 <p>Like <a href="../SAX/IContentHandler.html#characters">characters</a>, processing instruction
 data may have characters that need more than one <code>char</code>
 value. </p>

<br/><b>Parameter : </b> target The processing instruction target.
<br/><b>Parameter : </b> data The processing instruction data, or the empty string
        if none was supplied.  The data does not include any
        whitespace separating it from the target.
<br/><b>Exception : </b> ESAXException Any SAX exception.
<br/>
<p>
<a href="#top">Top</a>
</p>
<hr width="100%"/>
<a name="#skippedEntity">
<p>
<b>procedure</b> skippedEntity(<b>const</b> name : SAXString); </p>
</a> Receive notification of a skipped entity.
 This is not called for entity references within markup constructs 
 such as element start tags or markup declarations.  (The XML
 recommendation requires reporting skipped external entities.
 SAX also reports internal entity expansion/non-expansion, except
 within markup constructs.)

 <p>The Parser will invoke this method each time the entity is
 skipped.  Non-validating processors may skip entities if they
 have not seen the declarations (because, for example, the
 entity was declared in an external DTD subset).  All processors
 may skip external entities, depending on the values of the
 <code>http://xml.org/sax/features/external-general-entities</code>
 and the
 <code>http://xml.org/sax/features/external-parameter-entities</code>
 properties.</p>

<br/><b>Parameter : </b> name The name of the skipped entity.  If it is a
        parameter entity, the name will begin with '%', and if
        it is the external DTD subset, it will be the string
        &quot;[dtd]&quot;.
<br/><b>Exception : </b> ESAXException Any SAX exception.
<br/>
<p>
<a href="#top">Top</a>
</p>
</body>
</html>